<html>
<head><meta charset="utf-8"><title>docs · new members · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/index.html">new members</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/topic/docs.html">docs</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="222972112"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122652-new%20members/topic/docs/near/222972112" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Christopher Jefferson <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/topic/docs.html#222972112">(Jan 16 2021 at 09:45)</a>:</h4>
<p>Is there a specific place for people to talk about the Rust docs? I have some questions (in particular, is there a "style guide")?, as I seem some inconsistencies and aren't sure how, or if, they should be fixed.</p>



<a name="222972264"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122652-new%20members/topic/docs/near/222972264" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> bjorn3 <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/topic/docs.html#222972264">(Jan 16 2021 at 09:50)</a>:</h4>
<p>For code formatting, just run rustfmt. For api naming there is <a href="https://rust-lang.github.io/api-guidelines/naming.html">https://rust-lang.github.io/api-guidelines/naming.html</a>.</p>



<a name="222972334"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122652-new%20members/topic/docs/near/222972334" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Christopher Jefferson <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/topic/docs.html#222972334">(Jan 16 2021 at 09:51)</a>:</h4>
<p>Sorry, let me be more precise!</p>
<p>I was editing some docs in the Rust standard library to do with Logic Errors. I found some basically identical text, where in one place cell is referred to as [<code>Cell</code>], and in the other place just <code>Cell</code> is used. I can't really tell why <code>Cell</code> is used some places and [<code>Cell</code>] is used in other places. I wondered if there is a standard, or this is just drift based on who originally wrote the docs.</p>



<a name="222972392"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122652-new%20members/topic/docs/near/222972392" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Christopher Jefferson <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/topic/docs.html#222972392">(Jan 16 2021 at 09:52)</a>:</h4>
<p>(there should be backticks around the Cells, they got auto-formatted by Zulip)</p>



<a name="222972453"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122652-new%20members/topic/docs/near/222972453" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> bjorn3 <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/topic/docs.html#222972453">(Jan 16 2021 at 09:54)</a>:</h4>
<p><code>[`Cell`]</code> is turned into a link to the documentation of <code>Cell</code> by rustdoc.</p>
<p><span class="user-mention silent" data-user-id="325677">Christopher Jefferson</span> <a href="#narrow/stream/122652-new-members/topic/docs/near/222972392">said</a>:</p>
<blockquote>
<p>(there should be backticks around the Cells, they got auto-formatted by Zulip)</p>
</blockquote>
<p>FYI you can double the outer backticks like so: <code> ``[`Cell`]`` </code></p>



<a name="222984759"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122652-new%20members/topic/docs/near/222984759" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/topic/docs.html#222984759">(Jan 16 2021 at 14:40)</a>:</h4>
<p><span class="user-mention" data-user-id="325677">@Christopher Jefferson</span> there's not a <em>standard</em> but what I've seen people do is link the item the first time it's used and use inline code blocks everywhere else</p>



<a name="222984776"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122652-new%20members/topic/docs/near/222984776" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/122652-new-members/topic/docs.html#222984776">(Jan 16 2021 at 14:41)</a>:</h4>
<p>Unfortunately the docs team no longer really exists so I don't think there's any centralized guide</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>